/**
 * 版权所有：厦门市巨龙信息科技有限公司
 * Copyright 2023 Xiamen Dragoninfo Eng. Co. Ltd.
 * All right reserved.
 */
package com.github.alfred.tool;

import org.redisson.api.RTopic;
import org.redisson.client.protocol.ScoredEntry;

import java.time.Duration;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;

/**
 * 类说明
 * 基于redisson存储的信息
 *
 * @author chengh
 * @date 2023/5/17 10:39
 */
public interface ClientStore {


    /**
     * 指定缓存失效时间
     *
     * @param key  键
     * @param time 时间(秒)
     * @return boolean true false
     */
    boolean expire(String key, long time);

    /**
     * 指定缓存失效时间
     *
     * @param key      键
     * @param duration 时间
     * @return boolean true false
     */
    boolean expire(String key, Duration duration);


    /**
     * 根据key 获取过期时间
     *
     * @param key 键 不能为null
     * @return time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.
     */
    Long getExpire(String key);

    /**
     * 判断key是否存在
     *
     * @param key 键
     * @return true 存在 false不存在
     */
    boolean hasKey(String key);

    /**
     * 删除缓存
     *
     * @param key 可以传一个值 或多个
     */
    boolean del(String... key);

    /**
     * 删除缓存
     *
     * @param key 可以传一个值
     */
    boolean del(String key);

    /**
     * 普通缓存获取
     *
     * @param key 键
     * @return 值
     */
    Object get(String key);

    /**
     * 批量缓存获取
     *
     * @param keys
     * @return
     */
    List<Object> mGet(Collection<String> keys);

    /**
     * 普通缓存放入
     *
     * @param key   键
     * @param value 值
     * @return true成功 false失败
     */
    boolean set(String key, Object value);

    /**
     * 普通缓存放入并设置时间
     *
     * @param key   键
     * @param value 值
     * @param time  时间(秒) time要大于 如果time小于等于 将设置无限期
     * @return true成功 false 失败
     */
    boolean set(String key, Object value, int time);

    boolean set(String key, Object value, int time, TimeUnit timeUnit);

    /**
     * 递增
     *
     * @param key   键
     * @param delta 要增加几(大于)
     * @return Long
     */
    Long addAndGet(String key, long delta);

    /**
     * 自增
     *
     * @param key      key
     * @param liveTime 周期
     * @return
     */
    Long increment(String key, long liveTime);

    /**
     * 初始AtomicLong
     *
     * @param key      建
     * @param value    值
     * @param liveTime 周期
     */
    void initAtomicLong(String key, Long value, long liveTime);

    /**
     * 重置
     *
     * @param key key
     * @return void
     */
    void resetAutoNumber(String key);

    /**
     * 递减
     *
     * @param key   键
     * @param delta 要减少几(小于)
     * @return Long
     */
    Long decr(String key, long delta);

    /**
     * HashGet
     *
     * @param key  键 不能为null
     * @param item 项 不能为null
     * @return 值
     */
    Object hget(String key, String item);

    /**
     * 获取hashKey对应的所有键值
     *
     * @param key 键
     * @return 对应的多个键值
     */
    Map<Object, Object> hmget(String key);

    /**
     * HashSet
     *
     * @param key 键
     * @param map 对应多个键值
     * @return true 成功 false 失败
     */
    boolean hmset(String key, Map<String, Object> map);


    /**
     * HashSet 并设置时间
     *
     * @param key  键
     * @param map  对应多个键值
     * @param time 时间(秒)
     * @return true成功 false失败
     */
    boolean hmset(String key, Map<String, Object> map, long time);

    /**
     * 向一张hash表中放入数据,如果不存在将创建
     *
     * @param key   键
     * @param item  项
     * @param value 值
     * @return true 成功 false失败
     */
    boolean hset(String key, String item, Object value);

    /**
     * 向一张hash表中放入数据,如果不存在将创建
     *
     * @param key   键
     * @param item  项
     * @param value 值
     * @param time  时间(秒) 注意:如果已存在的hash表有时间,这里将会替换原有的时间
     * @return true 成功 false失败
     */
    boolean hset(String key, String item, Object value, long time);

    /**
     * 删除hash表中的值
     *
     * @param key  键 不能为null
     * @param item 项 可以使多个 不能为null
     */
    long hdel(String key, Object... item);

    /**
     * 判断hash表中是否有该项的值
     *
     * @param key  键 不能为null
     * @param item 项 不能为null
     * @return true 存在 false不存在
     */
    boolean hHasKey(String key, String item);

    /**
     * hash递增 如果不存在,就会创建一个 并把新增后的值返回
     *
     * @param key  键
     * @param item 项
     * @param by   要增加几(大于)
     * @return double
     */
    double hincr(String key, String item, double by);

    /**
     * hash递减
     *
     * @param key  键
     * @param item 项
     * @param by   要减少记(小于)
     * @return double
     */
    double hdecr(String key, String item, double by);

    /**
     * 根据key获取Set中的所有值
     *
     * @param key 键
     * @return Set<Object>
     */
    Set<Object> sGet(String key);

    /**
     * 根据value从一个set中查询,是否存在
     *
     * @param key   键
     * @param value 值
     * @return true 存在 false不存在
     */
    Boolean sHasKey(String key, Object value);

    /**
     * 将数据放入set缓存
     *
     * @param key    键
     * @param values 值 可以是多个
     */
    Boolean sSet(String key, Object... values);

    List<Object> sMembers(String key);

    /**
     * 将set数据放入缓存
     *
     * @param key    键
     * @param time   时间(秒)
     * @param values 值 可以是多个
     * @return
     */
    Boolean sSetAndTime(String key, long time, Object... values);

    /**
     * 获取set缓存的长度
     *
     * @param key 键
     * @return int
     */
    int sGetSetSize(String key);


    /**
     * 移除值为value的
     *
     * @param key    键
     * @param values 值 可以是多个
     * @return boolean
     */
    boolean setRemove(String key, Object... values);

    /**
     * 获取list缓存的内容
     *
     * @param key   键
     * @param start 开始
     * @param end   结束  到 -代表所有值
     * @return List<Object>
     */
    List<Object> lGet(String key, int start, int end);

    /**
     * 获取list缓存的长度
     *
     * @param key 键
     * @return int
     */
    int lGetListSize(String key);

    /**
     * 通过索引 获取list中的值
     *
     * @param key   键
     * @param index 索引 index>=时，  表头， 第二个元素，依次类推；index<时，-，表尾，-倒数第二个元素，依次类推
     * @return Object
     */
    Object lGetIndex(String key, int index);

    /**
     * 将list放入缓存
     *
     * @param key   键
     * @param value 值
     * @return boolean
     */
    boolean lSet(String key, Object value);

    /**
     * 将list放入缓存
     *
     * @param key   键
     * @param value 值
     * @param time  时间(秒)
     * @return boolean
     */
    boolean lSet(String key, Object value, long time);

    /**
     * 将list放入缓存
     *
     * @param key   键
     * @param value 值
     * @return boolean
     */
    boolean lSet(String key, List<Object> value);

    /**
     * 将list放入缓存
     *
     * @param key   键
     * @param value 值
     * @param time  时间(秒)
     * @return boolean
     */
    boolean lSet(String key, List<Object> value, long time);

    /**
     * 根据索引修改list中的某条数据
     *
     * @param key   键
     * @param index 索引
     * @param value 值
     * @return boolean
     */
    boolean lUpdateIndex(String key, int index, Object value);

    /**
     * 移除N个值为value
     *
     * @param key   键
     * @param count 移除多少个
     * @param value 值
     * @return
     */
    boolean lRemove(String key, int count, Object value);

    Collection<ScoredEntry<Object>> top(String key, int end);

    Collection<ScoredEntry<Object>> range(String key, int start, int end);

    void addScore(String key, String searchValue, int delta);

    /**
     * 添加到延迟队列
     * @param queueCode 队列名称
     * @param value 值
     * @param times 时间
     * @param timeUnit 单位
     * @param <T>
     */
    <T> void addDelayQueue(String queueCode, T value, Long times, TimeUnit timeUnit);

    /**
     * 获取队列
     * @param queueCode 队列名称
     * @param <T>
     * @return {@link T}
     */
    <T> T getDelayQueue(String queueCode) throws InterruptedException;

    /**
     * 消息发布
     * @param topic
     * @param msg
     * @return
     * @param <T>
     */
    <T> boolean publishMsg(String topic, T msg);

    /**
     * 获取队列
     * @param topic
     * @return
     */
    RTopic getTopic(String topic);
}
